Implemented an --ignore-file option to lint/report commands to ignore specific errors #515
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lobocv
changed the title
…s a YAML file that lists the paths for each rule for which to ignore errors for.
daveshanley
approved these changes
Jul 8, 2024
|
I want to upgrade |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The ignore-file is a YAML file that lists the paths for each rule for which to ignore errors for.
It can be used when introducing new linting rules which require breaking changes to existing production APIs.
In the example below, say I want to add a lint rule that new URLs must have a version in the path. This would break existing URLs which do not have versions in their path. We can use the ignorefile to grandfather those APIs while enforcing new APIs start using versioning.
Example ignorefile.yml using the burgershop API in the tests: